Skip to main content

Importing Custom Crystal Reports

The Report Manager is where you import and configure any Crystal Reports to be used within EPASS Reports. Once a report has been imported it will inherit all of the same functionality that regular EPASS Reports have, including Distribution, Scheduling, Bursting, and using the rich new UI controls.

Once a report has been imported into EPASS Reports it is saved inside the database – it only looks at the report file once and that is in order to upload it. Keep this in mind when making changes to a report in the future – if you’ve already imported it into EPASS Reports then you will need to update it in EPASS Reports after you have made your changes.

Installing the Barcode Font

To ensure that barcodes are displayed correctly when custom Crystal Reports are viewed in PDF format, the Libre Barcode 39, you need to install the Libre Barcode 39 font on your EPASS Reports server.

The font is free to use, and you can download it from Google Fonts.

To install the font, follow the directions below or contact EPASS Support for help.

  1. Download and extract (unzip) the Font file to the EPASS Reports server.

  2. Right-click LibreBarcode-39.ttf and then click Install for all users.

  3. Once installed, the Libre Barcode 39 font is available in the list of fonts.

Adding a Report

When you open the Report Manager screen fields in the top half of the screen should be empty and ready for you to add your report. If you had clicked on another report and there are now values in these fields you can click the New button to clear them for your new report.

img

To create a new report you need to specify the following values:

Report CodeAll Crystal Reports are assigned a report code beginning with “CR” and ending with a number. When you are adding a new report it will already have defaulted the next available number. You can choose a custom value but the report codes aren’t too important on their own – they mainly help you identify each report with a short code.
Report NameThis is the short name for the report that will appear in the report menus.
Displayed in MenusThis option controls if a report appears in the menu or not. If you want to temporarily remove a report from all users without changing security you can do that quickly using this option.
Sort CodeThe Sort Code allows you control the position of the report in the left menu. All reports have a Sort Code and the left menu is listed in Sort Code order.
Report GroupThis is the group (Invoicing, Purchasing, etc.) that the report belongs to on the left menu.
Report DescriptionThis is the long description for the report. Try to put as many details as you can about the report in this field, as that will help you easily find this report later when searching for specific terms.
Report FileChoose the report file (.RPT) to be uploaded.

The following actions can be performed for a report:

SaveThe Save button will save any values that were changed for this report. If you specified a Report File, which is required to add a new report, then that file will be uploaded and saved in the database.
NewClick the New button to clear the values in order to add a new report.
SecurityIf you are allowed to assign security to other users in EPASS then you will have the ability to assign security for a report from this screen. If you are not allowed to assign security to other users in EPASS then only you will have access to any new reports that you add.
DisableThis will remove the report from the menu and also remove any bookmarks for this report. You will still be able to access any previous history for the report.

Modifying Existing Reports

To modify an existing report you need to first find the report in the Search section at the bottom of the page. Use the Display Section drop down to help you find the report you’re looking for. You have the following options available in the Display Section drop down:

AllThis option will show all reports, including both EPASS Reports and Crystal Reports.
CustomThis option will show only your Crystal Reports.
ModulesEach module is also listed individually, allowing you to change the sort order module by module.

img

If you place a Crystal Report in one of the existing module menus you will likely also want to change the sort position within that menu – this is where the Sort Code comes in. In this example we have placed the Crystal Report called “Spiff Report” into the Invoice menu and gave it a Sort Code of 12 so that it displays between the OE-01 (Sort Code 10) and the OE-02 (Sort Code 20). To change the order you simply need to adjust your Sort Code value to place it in the appropriate position.

img

Downloading a Crystal Report

Once you have uploaded a Crystal Report you do not need to worry about saving a separate copy of it on your network (although you are welcome to!). If you ever need to make changes to the report in the future you can download the original report from EPASS Reports and it will be saved to the location of your choice in it’s original .RPT format. You can then make any required changes and re-upload it when ready.

img

Customizing the UI

In Crystal Reports you set up “parameters” that allow you to choose the criteria for your reports, then in the report itself, you make it filter out using those values. This is an example of the Crystal Report parameters screen that you would normally see:

img

When this report is added to EPASS Reports the parameters will be displayed using our own UI controls, giving you a consistent look to every report – whether they were created by EPASS or by your own team. Here’s what the same report looks like through EPASS Reports:

img

One thing you’ll notice about the parameter screen above is that the branch is just a text field – it would be nice if it was a drop-down letting you choose from your branches, rather than having to remember the codes. Crystal Reports does let you turn a field into a drop-down but it’s not an easy task unless you are an advanced Crystal Reports user.

In EPASS Reports, we have made it easy to replace fields with dropdowns, multi-select controls, finder controls (useful for choosing from larger tables like Customer, Model, etc.), and more. All you need is one formula field in the report named “EPASS-CONFIG”.

To Create the EPASS-CONFIG Formula

  1. In the Crystal Report editor, create a new formula.

img

  1. Name the formula EPASS-CONFIG.

img

info

The formula name is not case sensitive, but it must be spelled exactly as shown, otherwise it won't work.

  1. Inside the formula, define which user control is used for each parameter. If the user control needs to get data from somewhere, define the table as well.

​ Follow this structure:

Local StringVar ePASS_Parameters := "[ParameterName='PARAMETER_ID', UIControl='CONTROL_NAME', Table='TABLE_NAME']";
info
  • UIControl names are not case sensitive.

  • Parameter IDs are customizable.

  • If you want to use a hardcoded list for a SimpleDropDown or Combobox UI Control, then Table must equal blank (Table='').

img

Example
LOCAL StringVar ePASS_Parameters :=
"[ParameterName='StartDate', UIControl='DateControl', Table='']" +
"[ParameterName='EndDate', UIControl='DateControl', Table='']" +
"[ParameterName='Branch', UIControl='ComboBox', Table='Branch']";

The example above is what the formula would look like for our example report. We used ParamterName, UIControl, and Table in the example, but you can customize these parameter IDs if you need to.

The Branch parameter is defined as a “Combobox” with the data coming from the table “Branch”.

Once this formula is in place, the Branch selection is changed to a more user-friendly control.

img

Bursting a Crystal Report

To burst a Crystal report, you need to add a specific code string to the EPASS-CONFIG formula.

  1. Open the EPASS-CONFIG formula.
  2. Enter the bursting code string using the example below.
Example
LOCAL StringVar EPASS_Parameters :=
"[ParameterName='Tech', UIControl='ComboBox', Table='Salesperson', isBurst=true]";
info

The parameters must be entered in the order shown (ParameterName, UIControl, Table, isBurst), otherwise you won't be able to select the Burst Report option within the report parameters.

img

Any custom reports built by EPASS will start to include the formula to use rich user controls, but any report writer who is familiar with formulas is welcome to use them as well. We will also include the following comment in the formula which documents how the formula works.

Configuration File for EPASS Reports

EPASS Reports will read an .rpt file to determine the basic types of parameters to display to the user. In many cases, we want to provide the user of the report a better user experience by using our rich user interface controls.

For example, a report may have a "branch" parameter which is simply a "string" value. If we want EPASS Reports to instead display a search tool, we can indicate that here. Any parameters omitted from this file are treated as their basic type.

UI Types may include:

UI TypeCodeInterface Control
SearchUIControl='Search'img
DropdownUIControl='SimpleDropdown'img
Combo BoxUIControl='Combobox'img
Text BoxUIControl='Textbox'img
IntegerUIControl='Integer'img
DecimalUIControl='Decimal'img
DateUIControl='DateControl'img
Relative DateUIControl='RelativeDateControl'img
Check boxUIControl='Checkbox'img
TimeUIControl='TimeControl'img
Date and TimeUIControl='DateTimeControl'img
info
  • Spaces between the = sign do not matter. A=B and A = B are considered identical.
  • Make sure parameters ALWAYS follow the order of ParameterName, UIControl, Table—never switch these around.
  • Combo Box and Dropdown don't need to point to a table. These UI types can use values that have been hardcoded in the Crystal Report. In this case, make sure that Table is blank in your formula (Table='').
  • Search needs a table. Any table or view value must have a "Code" and "Description" field.

Feature Usage Report

As users navigate throughout the system, a log of which features, menus, and buttons were used is kept in a statistics table. This provides both the customer and EPASS with an understanding of which features are most favoured and which features are rarely used.

The statistics log tracks: logging in and out, session expirations, menu clicks, and any buttons that were clicked. We can, for example, view how often the 'right-click' menu was used and compare it to the 'left-click' icon.

The report is easily modified in Crystal Reports to better suit the needs of how and what features would be monitored. For example, the report might be modified to omit specific user activity.

Logging the Report

The logging report allows a user to print entries from the standard EPASS logging table. This report can be used to view both EPASS Enterprise errors and EPASS Reports errors.

The report allows the user to select a date range and type of log entry.

img

Troubleshooting

"Missing Parameter Values" Error When Printing Crystal Reports with Subreports

img

This error occurs because the link between a main report parameter and subreport parameter is not properly configured. When printing reports with subreports, each main report parameter needs to be explicitly linked to a subreport parameter.

To resolve this error, follow these instructions to link each main and subreport parameter field.

  1. From the main report, right-click the subreport, and then click Change Subreport Links.
  2. In the Subreport Links window, select a parameter field in Available Fields, and then click the > button to move it to Fields to link to.
  3. Select the subreport field name that you want to link to from the Subreport parameter field to use dropdown.
  4. Click the Select data in subreport based on field checkbox, and then select the field from the dopdown. If the value of the field is coming from user input, clear the Select data in subreport based on field checkbox.

img

  1. Repeat steps 2–4 for each main report field that you need to link to a subreport field. When you're finished, click OK.

  2. Save the report and then upload it to EPASS Reports.

See Also

Updated

May 22, 2025